lambda-router

Lambda Router

A small and simple router to simplify managing routers in a NodeJS Lambda function.

NOTE: Prior to v2 (there was no v1) this package was owned by another maintainer (yu0819ki). You can find the old lamdba-router package here. This is effectively an entirely different package.

Installation

npm install lambda-router

Quick Start

const { Router } = require('lambda-router')
const router = Router({
  logger: console // uses logger-wrapper.
  includeErrorStack: process.env.stage !== 'prod'
})

router.post('/v1/endpoint', service.create)
router.get('/v1/endpoint/{id}', service.get)
router.put('/v1/endpoint/{id}', service.put)
router.delete('/v1/endpoint/{id}', service.delete)
router.unknown((event, { response }, path, method, routes) => {
  return response(404, {
    message: `You dun screwed up, now. ${path} doesn't exist!`
  })
})

async function handler (lambdaEvent, context) {
  context.callbackWaitsForEmptyEventLoop = false
  router.formatError((statusCode, error) => {
    error.errorType = getErrorType(statusCode) // custom method
    return error
  })
  let result = await router.route(lambdaEvent, context)

  return result.response
}

API

function Router ({
  logger, // logger-wrapper
  extractPathParameters = true, // merge proxy path parameters into event.pathParameters
  includeTraceId = true, // include TraceId header
  inluceErrorStack = false, // include stack traces with error responses
  cors = true, // include CORS header, can be a string to set header value or true for '*'
  parseBody = true, // parse JSON or URL encoded body into event
  decodeEvent = true, // merge URI decoded parameters for path and querystring
  normalizeHeaders = false // If true all headers will be lowercased, and the original headers will be placed on event.rawHeaders
} = {}) {
  route: async (event, context) => Promise<{
    isOk,
    endpoint,
    uri,
    response
  }
  get|post|put|delete: async (pattern, handler) => {}
  unknown: (event, context, path, method, routes) => {}
  beforeRoute: async (event, context, path, method)
}

Body Parsing

If parseBody is true and the request Content-Type is application/json or application/x-www-form-urlencoded the event.body will be replaced with a parsed object, and event.rawBody will contain the original, unparsed body string.

Routes

Routes can be registered with any of the http verb methods.

router.[get|post|put|delete](routePattern: string, handler: (event, context) => Object|Promise)

Route matching is done either literally or by path token. When a route is matched it's handler function is invoked, and the result is used as the response body. If a route pattern matches the path exactly it will be selected. If not, the route will try to match by token, replacing anything in curly braces with values from the path.

For example, the path /v1/endpoint/1234 will match the route pattern '/v1/endpoint/{id}', because the {id} section will be treated as a path token and match the value 1234.

If the router option extractPathParameters is set, the event.pathParameters will receive the id value as event.pathParameters.id: 1234. Similarly, querystring parameters will be merged into event.queryStringParameters.

Route handlers that return an object will get a default status code of 200, and the object will be passed to JSON.stringify before being returned. Handlers that throw an error will get a default status code of 500. If you throw an error object with a statusCode property it's value will replace the default 500 status code. To customize status code for successful responses see the Custom Response section below.

The Unknown Handler

When no route is matched the unknown handler is invoked. The default unknown handler will return a canned response containing the unmatched path, with a 404. You can replace the unknown handler by provider your own to router.unknown. This handler will function as a normal handler, returning a 200 unless it throws an error. Since errors default to status code 500, you should probably manually set the status code to 404.

There is a special case on the default unknown handler when the request has a match on the path but not on the method. In this case a 405 with a correct Allow header will be returned.

Middleware

You can use the beforeRoute method to define middleware that will run before attempting to match a registered route. This is useful for mutating the incoming event or context, or for running validations at the global level:

function redactAuthToken (event, context, path, method) {
  event.headers['Authorization'] = '--redacted'
}

function validateContentType (event, context, path, method) {
  if (!event.headers['Content-Type'].includes('application/json')) {
    const error = new Error('Content-Type must be JSON')
    error.statusCode = 400
    throw error
  }
}

// these will both run before any route matching occurs
router.beforeRoute(redactAuthToken)
router.beforeRoute(validateContentType)

router.post('/v1/endpoint', service.create)
router.get('/v1/endpoint/{id}', service.get)

Custom Response

The context object, the second parameter to route handlers, has a response property function. It can be used to provide custom status codes, custom headers, and control body serialization.

router.post('/v1/endpoint', handleDelete)

async function handleCreate({ headers }, { path, response })
  let dbItem = await createNewItem()
  return response(201, result, { Location: 'https://' + headers.Host + path + '/' + dbItem.id })

async function download({ headers }, { path, response })
  let file = getFileBuffer()
  return response(201, file, { 'Content-Type': 'application/octet-stream' })

Custom Headers

Fully-custom responses are sometimes undesirable, as they avoid some of the automatic behavior of normal respones (such as error formatting). If your only goal is to set a custom response header you can use response.setHeader

router.post('/route', (_, { response }) => {
    response.setHeader('Location', 'something')
    return { message: 'success' }
  })

Error Formatting

By default error's are serialized as responses, and either use the error.statusCode or a default 500 status code. If you want to control the error object, or perform custom instrumentation for errors, you can provide your own error formatter. The error formatter will be called with the status code and the error and must return the error that will be serialized for the response.

router.formatError((statusCode, error) => {
  error.errorType = getErrorType(statusCode) // custom method
  return error
})

Router response

When you call router.route you must provide the lambda event and context.

let result = await router.route(event, context)

Optionally you can provide the the path and/or method to route on, in case the default selection method does not match your needs

let result = await router.route(event, context, customPath, customMethod)

The router will match the route and return a promise that will wait on the matched route handler. The result looks like this

{
  isOk: boolean // is the status code a 2xx
  endpoint: string // the route pattern that matched
  uri: string // the real path from the event
  response: {
    statusCode: number,
    body: string // stringified route handler response, or custom response
    headers: {} // default headers or custom response headers
  }
}

Changelog

[2.12.0] - 2021-08-07

Added

• routes to unknown as 5th parameter
• statusCode: 405 to defaultUnknownRoute when other methods for the same path exist